Build: Detect circular dependencies with Madge #17924
Merged
+78
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iOvergaard
changed the title
madsrasmussen
approved these changes
Jan 15, 2025
There was a problem hiding this comment.
Looks good 🥳
I have updated the script in package.json to run the devops version too. Then we don't end up with inconsistent result.
We could consider setting an error threshold to 11 and fail the build if we exceed that until we start fixing the remaining issues 🤔
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is setting up a script to run Madge (effectively
npm run check:circularbut with Node.js) so the build can either fail or warn if circular dependencies are detected.There are 11 circular dependencies, so we might want to set this to warn until they are fixed.
Check this previous run to see what it looks like in error mode: https://github.com/umbraco/Umbraco-CMS/actions/runs/12689060972/job/35366940767
If you have changed one of the files that has a circular dependency, the error will also pop up as an annotation on that file in the "Files changed" view.
How to test
Run the script locally:
cd src/Umbraco.Web.UI.Client node devops/circular/index.js srcCheck that it shows the currently known circular dependencies.